home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / AIncludes / AppleGuide.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  15.4 KB  |  669 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        AppleGuide.a
  3. ;
  4. ;    Contains:    Apple Guide Interfaces.
  5. ;
  6. ;    Version:    Technology:    Mac OS 8
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    ©1994-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__APPLEGUIDE__') = 'UNDEFINED' THEN
  18. __APPLEGUIDE__ SET 1
  19.  
  20.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  21.     include 'Types.a'
  22.     ENDIF
  23.     IF &TYPE('__APPLEEVENTS__') = 'UNDEFINED' THEN
  24.     include 'AppleEvents.a'
  25.     ENDIF
  26.     IF &TYPE('__FILES__') = 'UNDEFINED' THEN
  27.     include 'Files.a'
  28.     ENDIF
  29.  
  30.  
  31. ;  Types
  32. ; typedef UInt32                         AGRefNum
  33.  
  34. ; typedef UInt32                         AGCoachRefNum
  35.  
  36. ; typedef UInt32                         AGContextRefNum
  37.  
  38. AGAppInfo                RECORD 0
  39. eventId                     ds.l    1                ; offset: $0 (0)
  40. refCon                     ds.l    1                ; offset: $4 (4)
  41. contextObj                 ds.l    1                ; offset: $8 (8)        ;  private system field
  42. sizeof                     EQU *                    ; size:   $C (12)
  43.                         ENDR
  44. ; typedef struct AGAppInfo *            AGAppInfoPtr
  45.  
  46. ; typedef AGAppInfoPtr *                AGAppInfoHdl
  47.  
  48. ;  Constants
  49.  
  50.  
  51.  
  52. kAGDefault                        EQU        0
  53. kAGFrontDatabase                EQU        1
  54. kAGNoMixin                        EQU        -1
  55.  
  56.  
  57. kAGViewFullHowdy                EQU        1                    ; Full-size Howdy
  58. kAGViewTopicAreas                EQU        2                    ; Full-size Topic Areas
  59. kAGViewIndex                    EQU        3                    ; Full-size Index Terms
  60. kAGViewLookFor                    EQU        4                    ; Full-size Look-For (Search)
  61. kAGViewSingleHowdy                EQU        5                    ; Single-list-size Howdy
  62. kAGViewSingleTopics                EQU        6                    ; Single-list-size Topics
  63.  
  64.  
  65. kAGFileMain                        EQU        'poco'
  66. kAGFileMixin                    EQU        'mixn'
  67. ;  To test against AGGetAvailableDBTypes
  68.  
  69. kAGDBTypeBitAny                    EQU        $00000001
  70. kAGDBTypeBitHelp                EQU        $00000002
  71. kAGDBTypeBitTutorial            EQU        $00000004
  72. kAGDBTypeBitShortcuts            EQU        $00000008
  73. kAGDBTypeBitAbout                EQU        $00000010
  74. kAGDBTypeBitOther                EQU        $00000080
  75.  
  76. ; typedef UInt16                         AGStatus
  77.  
  78. ;  Returned by AGGetStatus
  79.  
  80. kAGIsNotRunning                    EQU        0
  81. kAGIsSleeping                    EQU        1
  82. kAGIsActive                        EQU        2
  83. ;  Flags used in AGOpen, AGOpenWithSearch, AGOpenWithView
  84.  
  85. kHelpViewerSearchAll            EQU        $01
  86. ; typedef UInt16                         AGWindowKind
  87.  
  88. ;  Returned by AGGetFrontWindowKind
  89.  
  90. kAGNoWindow                        EQU        0
  91. kAGAccessWindow                    EQU        1
  92. kAGPresentationWindow            EQU        2
  93. ;  Error Codes
  94.  
  95. ;  Not an enum, because other OSErrs are valid.
  96. ; typedef SInt16                         AGErr
  97.  
  98. ;  Apple Guide error codes
  99.  
  100.                                                             ; -------------------- Apple event reply codes
  101. kAGErrUnknownEvent                EQU        -2900
  102. kAGErrCantStartup                EQU        -2901
  103. kAGErrNoAccWin                    EQU        -2902
  104. kAGErrNoPreWin                    EQU        -2903
  105. kAGErrNoSequence                EQU        -2904
  106. kAGErrNotOopsSequence            EQU        -2905
  107. kAGErrReserved06                EQU        -2906
  108. kAGErrNoPanel                    EQU        -2907
  109. kAGErrContentNotFound            EQU        -2908
  110. kAGErrMissingString                EQU        -2909
  111. kAGErrInfoNotAvail                EQU        -2910
  112. kAGErrEventNotAvailable            EQU        -2911
  113. kAGErrCannotMakeCoach            EQU        -2912
  114. kAGErrSessionIDsNotMatch        EQU        -2913
  115. kAGErrMissingDatabaseSpec        EQU        -2914
  116. kAGMissingSequenceMap            EQU        -2915                ; -------------------- Coach's Chalkboard reply codes
  117. kAGErrItemNotFound                EQU        -2925
  118. kAGErrBalloonResourceNotFound    EQU        -2926
  119. kAGErrChalkResourceNotFound        EQU        -2927
  120. kAGErrChdvResourceNotFound        EQU        -2928
  121. kAGErrAlreadyShowing            EQU        -2929
  122. kAGErrBalloonResourceSkip        EQU        -2930
  123. kAGErrItemNotVisible            EQU        -2931
  124. kAGErrReserved32                EQU        -2932
  125. kAGErrNotFrontProcess            EQU        -2933
  126. kAGErrMacroResourceNotFound        EQU        -2934                ; -------------------- API reply codes
  127. kAGErrAppleGuideNotAvailable    EQU        -2951
  128. kAGErrCannotInitCoach            EQU        -2952
  129. kAGErrCannotInitContext            EQU        -2953
  130. kAGErrCannotOpenAliasFile        EQU        -2954
  131. kAGErrNoAliasResource            EQU        -2955
  132. kAGErrDatabaseNotAvailable        EQU        -2956
  133. kAGErrDatabaseNotOpen            EQU        -2957
  134. kAGErrMissingAppInfoHdl            EQU        -2958
  135. kAGErrMissingContextObject        EQU        -2959
  136. kAGErrInvalidRefNum                EQU        -2960
  137. kAGErrDatabaseOpen                EQU        -2961
  138. kAGErrInsufficientMemory        EQU        -2962
  139. ;  Events
  140.  
  141. ;  Not an enum because we want to make assignments.
  142. ; typedef UInt32                         AGEvent
  143.  
  144. ;  Handy events for AGGeneral.
  145.  
  146.                                                             ; Panel actions (Require a presentation window).
  147. kAGEventDoCoach                    EQU        'doco'
  148. kAGEventDoHuh                    EQU        'dhuh'
  149. kAGEventGoNext                    EQU        'gonp'
  150. kAGEventGoPrev                    EQU        'gopp'
  151. kAGEventHidePanel                EQU        'pahi'
  152. kAGEventReturnBack                EQU        'gobk'
  153. kAGEventShowPanel                EQU        'pash'
  154. kAGEventTogglePanel                EQU        'patg'
  155. ;  Functions
  156.  
  157.  
  158. ;   AGClose
  159. ;   Close the database associated with the AGRefNum.
  160.  
  161.  
  162.  
  163. ;
  164. ; pascal AGErr AGClose(AGRefNum *refNum)
  165. ;
  166.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  167.         Macro
  168.         _AGClose
  169.             moveq               #17,D0
  170.             dc.w                $AA6E
  171.         EndM
  172.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  173.         IMPORT_CFM_FUNCTION AGClose
  174.     ENDIF
  175.  
  176.  
  177. ;   AGGeneral
  178. ;   Cause various events to happen.
  179.  
  180.  
  181.  
  182. ;
  183. ; pascal AGErr AGGeneral(AGRefNum refNum, AGEvent theEvent)
  184. ;
  185.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  186.         Macro
  187.         _AGGeneral
  188.             moveq               #13,D0
  189.             dc.w                $AA6E
  190.         EndM
  191.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  192.         IMPORT_CFM_FUNCTION AGGeneral
  193.     ENDIF
  194.  
  195.  
  196. ;   AGGetAvailableDBTypes
  197. ;   Return the database types available for this application.
  198.  
  199.  
  200.  
  201. ;
  202. ; pascal UInt32 AGGetAvailableDBTypes(void )
  203. ;
  204.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  205.         Macro
  206.         _AGGetAvailableDBTypes
  207.             moveq               #8,D0
  208.             dc.w                $AA6E
  209.         EndM
  210.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  211.         IMPORT_CFM_FUNCTION AGGetAvailableDBTypes
  212.     ENDIF
  213.  
  214.  
  215. ;   AGGetFrontWindowKind
  216. ;   Return the kind of the front window.
  217.  
  218.  
  219.  
  220. ;
  221. ; pascal AGWindowKind AGGetFrontWindowKind(AGRefNum refNum)
  222. ;
  223.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  224.         Macro
  225.         _AGGetFrontWindowKind
  226.             moveq               #12,D0
  227.             dc.w                $AA6E
  228.         EndM
  229.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  230.         IMPORT_CFM_FUNCTION AGGetFrontWindowKind
  231.     ENDIF
  232.  
  233.  
  234. ;   AGGetFSSpec
  235. ;   Return the FSSpec for the AGRefNum.
  236.  
  237.  
  238.  
  239. ;
  240. ; pascal AGErr AGGetFSSpec(AGRefNum refNum, FSSpec *fileSpec)
  241. ;
  242.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  243.         Macro
  244.         _AGGetFSSpec
  245.             moveq               #15,D0
  246.             dc.w                $AA6E
  247.         EndM
  248.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  249.         IMPORT_CFM_FUNCTION AGGetFSSpec
  250.     ENDIF
  251.  
  252.  
  253. ;   AGGetStatus
  254. ;   Return the status of Apple Guide.
  255.  
  256.  
  257.  
  258. ;
  259. ; pascal AGStatus AGGetStatus(void )
  260. ;
  261.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  262.         Macro
  263.         _AGGetStatus
  264.             moveq               #9,D0
  265.             dc.w                $AA6E
  266.         EndM
  267.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  268.         IMPORT_CFM_FUNCTION AGGetStatus
  269.     ENDIF
  270.  
  271.  
  272. ;   AGInstallCoachHandler
  273. ;   Install a Coach object location query handler.
  274.  
  275.  
  276.  
  277. ;
  278. ; pascal AGErr AGInstallCoachHandler(CoachReplyUPP coachReplyProc, long refCon, AGCoachRefNum *resultRefNum)
  279. ;
  280.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  281.         Macro
  282.         _AGInstallCoachHandler
  283.             moveq               #18,D0
  284.             dc.w                $AA6E
  285.         EndM
  286.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  287.         IMPORT_CFM_FUNCTION AGInstallCoachHandler
  288.     ENDIF
  289.  
  290.  
  291. ;   AGInstallContextHandler
  292. ;   Install a context check query handler.
  293.  
  294.  
  295.  
  296. ;
  297. ; pascal AGErr AGInstallContextHandler(ContextReplyUPP contextReplyProc, AEEventID eventID, long refCon, AGContextRefNum *resultRefNum)
  298. ;
  299.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  300.         Macro
  301.         _AGInstallContextHandler
  302.             moveq               #19,D0
  303.             dc.w                $AA6E
  304.         EndM
  305.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  306.         IMPORT_CFM_FUNCTION AGInstallContextHandler
  307.     ENDIF
  308.  
  309.  
  310. ;   AGIsDatabaseOpen
  311. ;   Return true if the database associated with the AGRefNum is open.
  312.  
  313.  
  314.  
  315. ;
  316. ; pascal Boolean AGIsDatabaseOpen(AGRefNum refNum)
  317. ;
  318.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  319.         Macro
  320.         _AGIsDatabaseOpen
  321.             moveq               #6,D0
  322.             dc.w                $AA6E
  323.         EndM
  324.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  325.         IMPORT_CFM_FUNCTION AGIsDatabaseOpen
  326.     ENDIF
  327.  
  328.  
  329. ;   AGOpen
  330. ;   Open a guide database.
  331.  
  332.  
  333.  
  334. ;
  335. ; pascal AGErr AGOpen(ConstFSSpecPtr fileSpec, UInt32 flags, Handle mixinControl, AGRefNum *resultRefNum)
  336. ;
  337.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  338.         Macro
  339.         _AGOpen
  340.             moveq               #1,D0
  341.             dc.w                $AA6E
  342.         EndM
  343.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  344.         IMPORT_CFM_FUNCTION AGOpen
  345.     ENDIF
  346.  
  347.  
  348. ;   AGOpenWithSearch
  349. ;   Open a guide database and preset a search string.
  350.  
  351.  
  352.  
  353. ;
  354. ; pascal AGErr AGOpenWithSearch(ConstFSSpecPtr fileSpec, UInt32 flags, Handle mixinControl, ConstStr255Param searchString, AGRefNum *resultRefNum)
  355. ;
  356.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  357.         Macro
  358.         _AGOpenWithSearch
  359.             moveq               #2,D0
  360.             dc.w                $AA6E
  361.         EndM
  362.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  363.         IMPORT_CFM_FUNCTION AGOpenWithSearch
  364.     ENDIF
  365.  
  366.  
  367. ;   AGOpenWithSequence
  368. ;   Open a guide database and display a presentation window sequence.
  369.  
  370.  
  371.  
  372. ;
  373. ; pascal AGErr AGOpenWithSequence(ConstFSSpecPtr fileSpec, UInt32 flags, Handle mixinControl, short sequenceID, AGRefNum *resultRefNum)
  374. ;
  375.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  376.         Macro
  377.         _AGOpenWithSequence
  378.             moveq               #4,D0
  379.             dc.w                $AA6E
  380.         EndM
  381.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  382.         IMPORT_CFM_FUNCTION AGOpenWithSequence
  383.     ENDIF
  384.  
  385.  
  386. ;   AGOpenWithView
  387. ;   Open a guide database and override the default view.
  388.  
  389.  
  390.  
  391. ;
  392. ; pascal AGErr AGOpenWithView(ConstFSSpecPtr fileSpec, UInt32 flags, Handle mixinControl, short viewNum, AGRefNum *resultRefNum)
  393. ;
  394.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  395.         Macro
  396.         _AGOpenWithView
  397.             moveq               #5,D0
  398.             dc.w                $AA6E
  399.         EndM
  400.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  401.         IMPORT_CFM_FUNCTION AGOpenWithView
  402.     ENDIF
  403.  
  404.  
  405. ;   AGQuit
  406. ;   Make Apple Guide quit.
  407.  
  408.  
  409.  
  410. ;
  411. ; pascal AGErr AGQuit(void )
  412. ;
  413.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  414.         Macro
  415.         _AGQuit
  416.             moveq               #16,D0
  417.             dc.w                $AA6E
  418.         EndM
  419.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  420.         IMPORT_CFM_FUNCTION AGQuit
  421.     ENDIF
  422.  
  423.  
  424. ;   AGRemoveCoachHandler
  425. ;   Remove the Coach object location query handler.
  426.  
  427.  
  428.  
  429. ;
  430. ; pascal AGErr AGRemoveCoachHandler(AGCoachRefNum *resultRefNum)
  431. ;
  432.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  433.         Macro
  434.         _AGRemoveCoachHandler
  435.             moveq               #20,D0
  436.             dc.w                $AA6E
  437.         EndM
  438.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  439.         IMPORT_CFM_FUNCTION AGRemoveCoachHandler
  440.     ENDIF
  441.  
  442.  
  443. ;   AGRemoveContextHandler
  444. ;   Remove the context check query handler.
  445.  
  446.  
  447.  
  448. ;
  449. ; pascal AGErr AGRemoveContextHandler(AGContextRefNum *resultRefNum)
  450. ;
  451.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  452.         Macro
  453.         _AGRemoveContextHandler
  454.             moveq               #21,D0
  455.             dc.w                $AA6E
  456.         EndM
  457.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  458.         IMPORT_CFM_FUNCTION AGRemoveContextHandler
  459.     ENDIF
  460.  
  461.  
  462. ;   AGStart
  463. ;   Start up Apple Guide in the background.
  464.  
  465.  
  466.  
  467. ;
  468. ; pascal AGErr AGStart(void )
  469. ;
  470.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  471.         Macro
  472.         _AGStart
  473.             moveq               #10,D0
  474.             dc.w                $AA6E
  475.         EndM
  476.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  477.         IMPORT_CFM_FUNCTION AGStart
  478.     ENDIF
  479.  
  480.  
  481.  
  482. ;  typedef's
  483.  
  484. AGFileFSSpecType        RECORD 0
  485. f                         ds        FSSpec
  486. sizeof                     EQU *                    ; size:   $46 (70)
  487.                         ENDR
  488.  
  489.  
  490. ; typedef short                         AGFileSelectorCountType
  491.  
  492. ; typedef short                         AGFileSelectorIndexType
  493.  
  494. ; typedef OSType                         AGFileSelectorType
  495.  
  496. ; typedef long                             AGFileSelectorValueType
  497.  
  498. ; typedef short                         AGFileDBType
  499.  
  500. AGFileDBMenuNamePtr        RECORD 0
  501. f                         ds        Str63
  502. sizeof                     EQU *                    ; size:   $40 (64)
  503.                         ENDR
  504.  
  505.  
  506. ; typedef short                         AGFileDBScriptType
  507.  
  508. ; typedef short                         AGFileDBRegionType
  509.  
  510. ; typedef short                         AGFileMajorRevType
  511.  
  512. ; typedef short                         AGFileMinorRevType
  513.  
  514. ; typedef short                         AGFileCountType
  515.  
  516. ;  Database types (for AGFileDBType parameter).
  517.  
  518. kAGFileDBTypeAny                EQU        0
  519. kAGFileDBTypeHelp                EQU        1
  520. kAGFileDBTypeTutorial            EQU        2
  521. kAGFileDBTypeShortcuts            EQU        3
  522. kAGFileDBTypeAbout                EQU        4
  523. kAGFileDBTypeOther                EQU        8
  524.  
  525.  
  526. ;
  527. ; pascal OSErr AGFileGetDBMenuName(const FSSpec *fileSpec, Str63 menuItemNameString)
  528. ;
  529.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  530.         IMPORT_CFM_FUNCTION AGFileGetDBMenuName
  531.     ENDIF
  532.  
  533. ;  Get the database type.
  534. ;
  535. ; pascal OSErr AGFileGetDBType(const FSSpec *fileSpec, AGFileDBType *databaseType)
  536. ;
  537.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  538.         IMPORT_CFM_FUNCTION AGFileGetDBType
  539.     ENDIF
  540.  
  541.  
  542. ;   Get the version of the software
  543. ;   that created this database.
  544.  
  545.  
  546. ;
  547. ; pascal OSErr AGFileGetDBVersion(const FSSpec *fileSpec, AGFileMajorRevType *majorRev, AGFileMinorRevType *minorRev)
  548. ;
  549.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  550.         IMPORT_CFM_FUNCTION AGFileGetDBVersion
  551.     ENDIF
  552.  
  553. ;  Get the database script and region information.
  554. ;
  555. ; pascal OSErr AGFileGetDBCountry(const FSSpec *fileSpec, AGFileDBScriptType *script, AGFileDBRegionType *region)
  556. ;
  557.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  558.         IMPORT_CFM_FUNCTION AGFileGetDBCountry
  559.     ENDIF
  560.  
  561. ;  Return the number of selectors in database.
  562. ;
  563. ; pascal AGFileSelectorCountType AGFileGetSelectorCount(const FSSpec *fileSpec)
  564. ;
  565.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  566.         IMPORT_CFM_FUNCTION AGFileGetSelectorCount
  567.     ENDIF
  568.  
  569.  
  570. ;   Get the i-th database selector (1 to AGFileSelectorCountType)
  571. ;   and its value.
  572.  
  573.  
  574. ;
  575. ; pascal OSErr AGFileGetSelector(const FSSpec *fileSpec, AGFileSelectorIndexType selectorNumber, AGFileSelectorType *selector, AGFileSelectorValueType *value)
  576. ;
  577.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  578.         IMPORT_CFM_FUNCTION AGFileGetSelector
  579.     ENDIF
  580.  
  581. ;  Return true if database is mixin.
  582. ;
  583. ; pascal Boolean AGFileIsMixin(const FSSpec *fileSpec)
  584. ;
  585.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  586.         IMPORT_CFM_FUNCTION AGFileIsMixin
  587.     ENDIF
  588.  
  589.  
  590. ;   Return the number of database files
  591. ;   of the specified databaseType and main/mixin.
  592. ;   Any file creator is acceptible,
  593. ;   but type must be kAGFileMain or kAGFileMixin.
  594.  
  595.  
  596. ;
  597. ; pascal AGFileCountType AGFileGetDBCount(short vRefNum, long dirID, AGFileDBType databaseType, Boolean wantMixin)
  598. ;
  599.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  600.         IMPORT_CFM_FUNCTION AGFileGetDBCount
  601.     ENDIF
  602.  
  603.  
  604. ;   Get the FSSpec for the dbIndex-th database
  605. ;   of the specified databaseType and main/mixin.
  606. ;   Any file creator is acceptible,
  607. ;   but type must be kAGFileMain or kAGFileMixin.
  608.  
  609.  
  610. ;
  611. ; pascal OSErr AGFileGetIndDB(short vRefNum, long dirID, AGFileDBType databaseType, Boolean wantMixin, short dbIndex, FSSpec *fileSpec)
  612. ;
  613.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  614.         IMPORT_CFM_FUNCTION AGFileGetIndDB
  615.     ENDIF
  616.  
  617.  
  618. ;   This selector must match with the application
  619. ;   creator in order for this file to appear in the 
  620. ;   application's Help menu. Ignored for mixin files
  621. ;   because they never appear in the Help menu anyway.
  622. ;   If empty (zeros), will appear in the Help menu
  623. ;   of any host application.
  624.  
  625.  
  626. ;
  627. ; pascal OSErr AGFileGetHelpMenuAppCreator(const FSSpec *fileSpec, OSType *helpMenuAppCreator)
  628. ;
  629.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  630.         IMPORT_CFM_FUNCTION AGFileGetHelpMenuAppCreator
  631.     ENDIF
  632.  
  633.  
  634. ;   This selector must match in the main and mixin
  635. ;   files in order for the mixin to mix-in with the main.
  636. ;   Empty (zeros) selectors are valid matches.
  637. ;   A '****' selector will mix-in with any main.
  638.  
  639.  
  640. ;
  641. ; pascal OSErr AGFileGetMixinMatchSelector(const FSSpec *fileSpec, OSType *mixinMatchSelector)
  642. ;
  643.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  644.         IMPORT_CFM_FUNCTION AGFileGetMixinMatchSelector
  645.     ENDIF
  646.  
  647.  
  648. ;   This is the text of the balloon for the
  649. ;   Help menu item for this database.
  650.  
  651.  
  652. ;
  653. ; pascal OSErr AGFileGetHelpMenuBalloonText(const FSSpec *fileSpec, Str255 helpMenuBalloonString)
  654. ;
  655.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  656.         IMPORT_CFM_FUNCTION AGFileGetHelpMenuBalloonText
  657.     ENDIF
  658.  
  659.  
  660. ;
  661. ; pascal OSErr AGGetSystemDB(AGFileDBType databaseType, Boolean wantMixin, FSSpec *pFileSpec)
  662. ;
  663.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  664.         IMPORT_CFM_FUNCTION AGGetSystemDB
  665.     ENDIF
  666.  
  667.     ENDIF ; __APPLEGUIDE__ 
  668.  
  669.